Foxit PDF SDK
FoxitPDFSDKPython3.Office2PDF类 参考
类 FoxitPDFSDKPython3.Office2PDF 继承关系图:
FoxitPDFSDKPython3.Base

静态 Public 成员函数

def ConvertFromExcel (src_excel_file_path, src_file_password, saved_pdf_path, setting_data)
 将Excel格式文件转换为PDF文件。 更多...
 
def ConvertFromExcel (src_excel_reader, src_file_password, saved_pdf_file_stream, setting_data)
 将Excel格式文件转换为PDF文件。 更多...
 
def ConvertFromPowerPoint (src_ppt_file_path, src_file_password, saved_pdf_path, setting_data)
 将PowerPoint格式文件转换为PDF文件。 更多...
 
def ConvertFromPowerPoint (src_ppt_reader, src_file_password, saved_pdf_file_stream, setting_data)
 将PowerPoint格式文件转换为PDF文件。 更多...
 
def ConvertFromWord (src_word_file_path, src_file_password, saved_pdf_path, setting_data)
 将Word格式文件转换为PDF文件。 更多...
 
def ConvertFromWord (src_word_reader, src_file_password, saved_pdf_file_stream, setting_data)
 将Word格式文件转换为PDF文件。 更多...
 
def GetVersion ()
 获取Foxit PDF转换SDK的版本。 更多...
 
def Initialize (library_path)
 初始化Foxit PDF转换。 更多...
 
def Release ()
 释放Foxit PDF转换分配的所有资源。 更多...
 

详细描述

此类可用于将Office(Word、Excel或PowerPoint)格式文件转换为PDF文件。 此功能是Foxit自主开发的产品,不依赖其他第三方引擎。 在使用"Conversion"模块之前,请确保Foxit PDF转换SDK包中名为"res"和"lib"的资源文件夹有效。 在使用此模块中的方法之前,请确保Foxit PDF SDK已通过函数FoxitPDFSDKPython3.Library.Initialize 使用包含"Office2PDF"模块的密钥成功初始化。

参见
FoxitPDFSDKPython3.Library

成员函数说明

◆ ConvertFromExcel() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromExcel (   src_excel_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

将Excel格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从XLSX格式文件的转换。

参数
[in]src_excel_file_pathExcel格式文件的路径。这不应该是空字符串。
[in]src_file_password(保留,尚不支持加密文件)输入Excel格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_path作为转换结果保存的PDF文件路径。这不应该是空字符串。
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ ConvertFromExcel() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromExcel (   src_excel_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

将Excel格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从XLSX格式文件的转换。 文件是一次性读取的,而不是逐步读取的。

参数
[in]src_excel_reader由用户实现的FileReaderCallback 对象, 用于加载Excel文档。它不应该是null
[in]src_file_password(保留,尚不支持加密文件)输入Excel格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象, 用于读取转换后PDF文件的内容。它不应该是null
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ ConvertFromPowerPoint() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromPowerPoint (   src_ppt_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

将PowerPoint格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从PPTX格式文件的转换。

参数
[in]src_ppt_file_pathPowerPoint格式文件的路径。这不应该是空字符串。
[in]src_file_password(保留,尚不支持加密文件)输入PowerPoint格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_path作为转换结果保存的PDF文件路径。这不应该是空字符串。
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ ConvertFromPowerPoint() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromPowerPoint (   src_ppt_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

将PowerPoint格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从PPTX格式文件的转换。 文件是一次性读取的,而不是逐步读取的。

参数
[in]src_ppt_reader由用户实现的FileReaderCallback 对象, 用于加载PowerPoint文档。它不应该是null
[in]src_file_password(保留,尚不支持加密文件)输入PowerPoint格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象, 用于读取转换后PDF文件的内容。它不应该是null
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ ConvertFromWord() [1/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromWord (   src_word_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

将Word格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从DOCX/DOC格式文件的转换。

参数
[in]src_word_file_pathWord格式文件的路径。这不应该是空字符串。
[in]src_file_password(保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_path作为转换结果保存的PDF文件路径。这不应该是空字符串。
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ ConvertFromWord() [2/2]

FoxitPDFSDKPython3.Office2PDF.ConvertFromWord (   src_word_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
static

将Word格式文件转换为PDF文件。

目前,此函数仅适用于Windows和Linux,并且仅支持从DOCX/DOC格式文件的转换。 文件是一次性读取的,而不是逐步读取的。

参数
[in]src_word_reader由用户实现的FileReaderCallback 对象, 用于加载Word文档。它不应该是null
[in]src_file_password(保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。
[in]saved_pdf_file_stream由用户实现的FoxitPDFSDKPython3.StreamCallback 对象, 用于读取转换后PDF文件的内容。它不应该是null
[in]setting_data用于转换的FoxitPDFSDKPython3.Office2PDFSettingData 对象。
返回
true表示成功,而false表示失败。

◆ GetVersion()

FoxitPDFSDKPython3.Office2PDF.GetVersion ( )
static

获取Foxit PDF转换SDK的版本。

此函数应在函数FoxitPDFSDKPython3.Office2PDF.Initialize 成功调用后调用。

返回
包含Foxit PDF转换SDK版本信息的字符串。

◆ Initialize()

FoxitPDFSDKPython3.Office2PDF.Initialize (   library_path)
static

初始化Foxit PDF转换。

在"Office2PDF"模块的生命周期内,此函数只能调用一次, 并且应该在"Office2PDF"模块中任何其他函数被调用之前首先调用。

参数
[in]library_pathFoxit PDF转换SDK库的路径。这不应该是空字符串。
返回
无。
注解
如果在函数FoxitPDFSDKPython3.Library.Initialize 中使用的许可证信息中未定义模块"Office2PDF", 这意味着用户没有使用Office2PDF相关函数的权限, 此函数将抛出异常FoxitPDFSDKPython3.e_ErrNoOffice2PDFModuleRight

◆ Release()

FoxitPDFSDKPython3.Office2PDF.Release ( )
static

释放Foxit PDF转换分配的所有资源。

当用户不使用"Office2PDF"模块时,应调用此函数释放库分配的所有内存块。

返回
无。